package org.shs.user.form;

import org.apache.struts.action.ActionForm;

/**
 * 
 * <br/>
 * <br/><b>Created:</b>&nbsp;&nbsp; 11-Nov-2008 23:55:53
 *
 * @author anirvan
 *
 */
@SuppressWarnings("serial")
public class LoginForm extends ActionForm
{ 
   /**
    * The password entered by the user
    */
   private String password = "";
   
   /**
    * The username entered by the user
    */
   private String username = "";
   
   /**
    * The user-id [system-wide ID is constant 
    * so we need to use the same variable in 
    * every form bean] 
    */
   private String id = "";
   
   /**
    * The id of the current session
    */
   private String sessionId = "";
   
   /**
    * Return the Password entered by the user
    * @return The entered password.
    */
   public String getPassword()
   {
      return password;
   }
   
   /**
    * Set the password entered by the user
    * @param password The entered password.
    */
   public void setPassword(String password)
   {
      this.password = password;
   }
   
   /**
    * Returns the username entered by the user
    * @return The username entered.
    */
   public String getUsername()
   {
      return username;
   }
   
   /**
    * Sets the username entered by the user
    * @param username The username entered
    */
   public void setUsername(String username)
   {
      this.username = username;
   }

   /**
    * Returns the session ID of user logging in
    * @return the session ID of user logging in
    */
   public String getSessionId()
   {
      return sessionId;
   }

   /**
    * Set the session ID of user logging in
    * @param sessionId The session ID of user logging in
    */
   public void setSessionId(String sessionId)
   {
      this.sessionId = sessionId;
   }

   /**
    * Returns the user-id of the logged person
    * @return the user-id of the logged person
    */
   public String getId()
   {
      return id;
   }

   /**
    * Sets the user-id of the logged person
    * @param id The user-id of the logged person
    */
   public void setId(String id)
   {
      this.id = id;
   }
}
